Skip to content

docs: Add $PROMPT variable to issue_body description in CI docs#13

Merged
hawkeyexl merged 1 commit intomainfrom
promptless/add-prompt-variable-to-ci-docs
Mar 1, 2026
Merged

docs: Add $PROMPT variable to issue_body description in CI docs#13
hawkeyexl merged 1 commit intomainfrom
promptless/add-prompt-variable-to-ci-docs

Conversation

@promptless
Copy link
Contributor

@promptless promptless bot commented Feb 27, 2026

Open this suggestion in Promptless to view citations and reasoning process

Updates the CI integration page to document $PROMPT as an available template variable in the issue_body input, alongside the existing $RESULTS and $RUN_URL variables. This aligns with the GitHub Action README documentation.

Trigger Events

doc-detective/github-action PR #59: docs: Add `integrations` and `prompt` inputs to README

Promptless Research (1 GitHub PR)

Agent Response

I've reviewed PR #59 which adds documentation for the integrations and prompt inputs to the GitHub Action README.

Summary

After reviewing the documentation, I found that most content was already well-documented:

  • Integrations page (fern/pages/docs/get-started/integrations.mdx) - Already has comprehensive coverage of supported integrations, custom prompts, and behaviors
  • Contributor docs (fern/pages/contribute/repos/github-action.md) - Already documents $PROMPT, $RESULTS, and $RUN_URL variables, plus all integration details

The only gap was in the CI integration page (fern/pages/docs/get-started/ci.mdx), where the issue_body description in the Issue options table was missing the $PROMPT template variable.

Created Suggestion

I created one suggestion to add $PROMPT to the issue_body description in the CI docs:

Before:

| `issue_body` | See default | Issue body (`$RESULTS` inserts test results, `$RUN_URL` inserts workflow URL) |

After:

| `issue_body` | See default | Issue body (`$RESULTS` inserts test results, `$RUN_URL` inserts workflow URL, `$PROMPT` inserts the prompt text) |

This small update ensures the CI page stays consistent with the GitHub Action README and the contributor documentation.


Tip: Add or adjust Promptless's style guide in Agent Knowledge Base ✍️

@github-actions
Copy link

@promptless
Copy link
Contributor Author

promptless bot commented Mar 1, 2026

Just a reminder: If you'd like me to act on any feedback you have via Github comments, just type @Promptless in your suggestion and I'll get right on it! (I won't show up in the user dropdown, but I'll process any request that has @Promptless in the comment body.)

@hawkeyexl hawkeyexl marked this pull request as ready for review March 1, 2026 03:17
Copilot AI review requested due to automatic review settings March 1, 2026 03:17
@hawkeyexl hawkeyexl merged commit 00070c0 into main Mar 1, 2026
1 check passed
@hawkeyexl hawkeyexl deleted the promptless/add-prompt-variable-to-ci-docs branch March 1, 2026 03:17
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the CI integration documentation to include $PROMPT as a supported template variable for the issue_body input, aligning the CI docs with the GitHub Action README and other contributor documentation.

Changes:

  • Documented $PROMPT in the issue_body description alongside $RESULTS and $RUN_URL.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants